Skip to content

docs: polish README for promotion#23

Merged
edochi merged 1 commit intomainfrom
docs/readme-polish
Mar 29, 2026
Merged

docs: polish README for promotion#23
edochi merged 1 commit intomainfrom
docs/readme-polish

Conversation

@edochi
Copy link
Copy Markdown
Owner

@edochi edochi commented Mar 29, 2026

Summary

  • Add one-liner summary after badges for skimmers
  • Add target audience line (Obsidian, Zettelkasten, docs-as-code, etc.)
  • Fix all output examples to match real KeyValue table format (77-char wide, modern borders, separators between every row, field name on top border)
  • Change search example to demonstrate semantic search (query "how to get in touch" finds alice.md without keyword match)
  • Add CI-ready bullet to features list
  • Simplify "Try it yourself" — point to user's own files first

Test plan

  • Visual review of rendered README on GitHub

Co-Authored-By: Claude <noreply@anthropic.com>
@edochi edochi merged commit 781a344 into main Mar 29, 2026
6 checks passed
@edochi edochi deleted the docs/readme-polish branch March 29, 2026 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant